home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / cpp_libs / linklist / source.lha / doc / lGetNode.3 < prev    next >
Text File  |  1993-08-08  |  1KB  |  53 lines
  1. '.so tmac.clman
  2. .TH "lGetNode"
  3. .IX lGetNode
  4. .SH NAME
  5. lGetNode - Get node.
  6. .SH SYNOPSIS
  7. int
  8. .BR "lGetNode" "(id, which, data, size)"
  9. .br
  10. .RT
  11. .RP
  12. In    int    id    identifier of linked list
  13. .RP
  14. In    int    which    which node must be retrieved
  15. .RP
  16. Out    Byte    *data    data of node
  17. .RP
  18. In    int    size    size of data
  19. .DT
  20. .SH DESCRIPTION
  21. \fBlGetNode\fP gets the data of a node of a linked list. Which node must
  22. be retrieved can be specified by \fIwhich\fP. The first node, the current
  23. node, the node before or after the current node and the node at the end
  24. of the list can be retrieved.
  25. .br
  26. Backward retrieving is only possible for doubly linked list. A previous
  27. node can't be retrieved for singly linked lists.
  28. .br
  29. When the retrieved node is the first or the last node, the return code
  30. will have the value lFIRST or lLAST. For the other nodes the routine
  31. returns lSUCCESS.
  32. .SH PARAMETER DEFINITIONS
  33. .if t .ta 0.2i 1.5i
  34. \fIwhich\fP :
  35. .nf
  36.     lFIRST    first node
  37.     lPREVIOUS    previous node
  38.     lCURRENT    current node
  39.     lNEXT    next node
  40.     lLAST    last node
  41. .fi
  42. .SH RETURN CODES
  43. .nf
  44. Return on success :
  45.     lSUCCESS, lFIRST, lLAST
  46. Return on error :
  47. .fi
  48. .in +02.i
  49. lUNKNOWN_ID, lEMPTY_LIST, lWRONG_WHICH, lEOL, lNOT_DOUBLY, lSIZE_NE
  50. .in -02.i
  51. .SH AUTHOR
  52. Anita Eijs (TNO - Bouw - BouwInformatica)
  53.